XIQS Get Global Parameter

From IQsimWiki

Jump to: navigation, search

XIQS Get Global Parameter - Global Parameters Management

Description
getXIQSGlobalParam ( String param_name [, Long id_partition ] ) 
Get the value of a named global parameter. If the user is logged in as the administrator, it is mandatory to specify partition. Otherwise, the user's partition is assumed.
Parameters

String param_name 

Name of the requested global parameter.

[ Long id_partition ] 

Id of the partition which global parameter refers to (mandatory if the user is logged in as the administrator, ignored otherwise).
Return Values
String value
Value of the requested global parameter.


Error Data structure ( Error Management ) 

Possible failure code returns
 *ERR_OBJ_NOT_FOUND (404) ERR_MSG_GPAR_NOT_FOUND
 *ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
See Also

getXIQSGlobalParamList

createXIQSGlobalParam

updateXIQSGlobalParam

deleteXIQSGlobalParam

Retrieved from "http://vpn.iqsim.com:8080/iqSimWiki/index.php?title=XIQS_Get_Global_Parameter"
Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List